/*
 * Copyright (c) 2004-2022, University of Oslo
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 *
 * 3. Neither the name of the copyright holder nor the names of its contributors 
 * may be used to endorse or promote products derived from this software without
 * specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.hisp.dhis.validation.comparator;

import java.util.Date;
import java.util.List;
import lombok.Getter;
import lombok.Setter;
import lombok.ToString;
import org.hisp.dhis.common.OpenApi;
import org.hisp.dhis.common.Pager;
import org.hisp.dhis.common.PagerUtils;
import org.hisp.dhis.common.UID;
import org.hisp.dhis.organisationunit.OrganisationUnit;
import org.hisp.dhis.validation.ValidationRule;

/**
 * @author Stian Sandvold
 */
@Setter
@Getter
@ToString
public class ValidationResultQuery {

  private Boolean skipPaging;

  private Boolean paging;

  private int page = 1;

  private int pageSize = Pager.DEFAULT_PAGE_SIZE;

  @OpenApi.Description(
      "Optional list of validation rule UIDs to filter. If empty the list is not restricting the query.")
  @OpenApi.Property({UID.class, ValidationRule.class})
  private List<String> vr;

  @OpenApi.Description(
      "Optional list of organisation unit UIDs to filter. If empty the list is not restricting the query")
  @OpenApi.Property({UID.class, OrganisationUnit.class})
  private List<String> ou;

  @OpenApi.Description(
      "Optional list of ISO-Date expressions to filter. If empty the list is not restricting the query")
  private List<String> pe;

  @OpenApi.Description(
      "Optional filter to select only results that have been created on or after the given date")
  private Date createdDate;

  private List<String> fields;

  public ValidationResultQuery() {}

  public boolean isSkipPaging() {
    return PagerUtils.isSkipPaging(skipPaging, paging);
  }
}
